Resource URL: /platform/<<version=3>>/network/groupnets/<GROUPNET>

    Overview: This resource exposes a single OneFS network groupnet.

     Methods: GET, PUT, DELETE

********************************************************************************

Method GET: View a network groupnet.

       URL: GET /platform/<<version=3>>/network/groupnets/<GROUPNET>

There are no query arguments for this method.

GET response body schema:
{
  "type": "object", 
  "properties": {
    "groupnets": {
      "items": {
        "type": "object", 
        "properties": {
          "subnets": {
            "items": {
              "type": "string"
            }, 
            "type": "array", 
            "description": "Name of the subnets in the groupnet."
          }, 
          "dns_servers": {
            "items": {
              "type": "string"
            }, 
            "type": "array", 
            "description": "List of Domain Name Server IP addresses.", 
            "maxItems": 3
          }, 
          "description": {
            "type": "string", 
            "description": "A description of the groupnet.", 
            "maxLength": 128
          }, 
          "dns_cache_enabled": {
            "type": "boolean", 
            "description": "DNS caching is enabled or disabled."
          }, 
          "dns_search": {
            "items": {
              "type": "string"
            }, 
            "type": "array", 
            "description": "List of DNS search suffixes.", 
            "maxItems": 6
          }, 
          "dns_options": {
            "uniqueItems": true, 
            "items": {
              "enum": [
                "rotate"
              ], 
              "type": "string"
            }, 
            "type": "array", 
            "description": "List of DNS resolver options."
          }, 
          "server_side_dns_search": {
            "type": "boolean", 
            "description": "Enable or disable appending nodes DNS search  list to client DNS inquiries directed at SmartConnect service IP."
          }, 
          "id": {
            "type": "string", 
            "description": "Unique Interface ID."
          }, 
          "name": {
            "type": "string", 
            "description": "The name of the groupnet.", 
            "maxLength": 32
          }
        }
      }, 
      "type": "array"
    }
  }
}

********************************************************************************

Method PUT: Modify a network groupnet.

       URL: PUT /platform/<<version=3>>/network/groupnets/<GROUPNET>

There are no query arguments for this method.

PUT request body schema:
{
  "type": "object", 
  "properties": {
    "dns_servers": {
      "items": {
        "type": "string"
      }, 
      "type": "array", 
      "description": "List of Domain Name Server IP addresses.", 
      "maxItems": 3
    }, 
    "name": {
      "type": "string", 
      "description": "The name of the groupnet.", 
      "maxLength": 32
    }, 
    "dns_cache_enabled": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "DNS caching is enabled or disabled."
        }
      ]
    }, 
    "dns_search": {
      "items": {
        "type": "string"
      }, 
      "type": "array", 
      "description": "List of DNS search suffixes.", 
      "maxItems": 6
    }, 
    "dns_options": {
      "uniqueItems": true, 
      "items": {
        "enum": [
          "rotate"
        ], 
        "type": "string"
      }, 
      "type": "array", 
      "description": "List of DNS resolver options."
    }, 
    "server_side_dns_search": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "Enable or disable appending nodes DNS search  list to client DNS inquiries directed at SmartConnect service IP."
        }
      ]
    }, 
    "description": {
      "type": "string", 
      "description": "A description of the groupnet.", 
      "maxLength": 128
    }
  }
}

There is no response body for this method.

********************************************************************************

Method DELETE: Delete a network groupnet.

          URL: DELETE /platform/<<version=3>>/network/groupnets/<GROUPNET>

There are no query arguments for this method.

There is no response body for this method.
